home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / tv260.zip / TVAULT.DOC < prev    next >
Text File  |  1991-08-28  |  20KB  |  661 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                                      ----------------------
  8.                                                        T i m e  V a u l t
  9.                                                      ----------------------
  10.                                                     a time banking door for
  11.                                                         Searchlight BBS 2.x
  12.  
  13.                                                                 version 2.6
  14.                                                       Copyright (c) 1989-91
  15.                                                     CCS Systems & Jim Barry
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                                Table of Contents
  71.                                -----------------
  72.  
  73.      Introduction .................................................. 2
  74.  
  75.      Registration Information ...................................... 2
  76.  
  77.      Setup & Installation .......................................... 3
  78.  
  79.      Advanced Options/Extra Features ............................... 4
  80.        Deposit .................................................. 4
  81.        Withdraw ................................................. 4
  82.        TVAULT.CFG ............................................... 5
  83.        Transfer ................................................. 6
  84.        Goodbye .................................................. 6
  85.        Sysop Utilities .......................................... 6
  86.        2-Sysop .................................................. 7
  87.        Status Line .............................................. 7
  88.  
  89.      Sample Command Lines .......................................... 7
  90.  
  91.      TVAULT.LOG Activity Log File .................................. 8
  92.  
  93.      Sysop Chat Mode ............................................... 8
  94.  
  95.      Acknowledgments ............................................... 9
  96.  
  97.      Disclaimer .................................................... 9
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                      - 1 -
  131.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  132.  
  133.  
  134.  
  135.  
  136.      ------------
  137.      Introduction
  138.      ------------
  139.  
  140.      Time Vault is a professional quality, utility/game door written for
  141.   Searchlight bulletin board software, Version 2.x and up.  The original
  142.   version was released in 1989 and has been constantly gone through
  143.   revisions and upgrades.  The current version is loaded with many features
  144.   and we feel this is the best utility door available for SLBBS.
  145.  
  146.      Here is a listing of major features offered by Time Vault:
  147.  
  148.        1.  Allows users to store system time and withdraw at a later time.
  149.        2.  Blends into Searchlight by utilitizing the same look and feel.
  150.        3.  Color choices come from your SL configuration.
  151.        4.  Transfer feature to give time to a different user. (option)
  152.        5.  Local status line with ALT/F-key support. (option)
  153.        6.  Goodbye feature to allow BBS logoff via door. (option)
  154.        7.  Configure maximum balances/withdrawals via access levels using a
  155.            text file. (option)
  156.        8.  Scans EVENT.DEF file to ensure Time Vault withdrawals do not
  157.            interfere with an upcoming event.
  158.        9.  Sysop chat mode just like Searchlight.
  159.       10.  Sysop Utility feature allowing Sysops to modify user account
  160.            balances and print listings of the vault file.
  161.       11.  Activity log of all Time Vault transactions.
  162.  
  163.  
  164.      ------------
  165.      Registration
  166.      ------------
  167.  
  168.      Time Vault is distributed as 'shareware' and continued use after an
  169.   acceptable trial period requires a registration fee.  The trial period is
  170.   21 days (3 weeks), after which, a registration fee of $15 (US funds) must
  171.   be paid to the author.  If you fail to register after the 21 day trial
  172.   period, you MUST discontinue use of the software.  The only way shareware
  173.   authors get compensated for their efforts is through registrations.
  174.   Please support the shareware marketing concept and encourage authors to
  175.   produce updates, as well as new shareware programs.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                                      - 2 -
  197.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  198.  
  199.  
  200.  
  201.  
  202.        ------------------
  203.        Setup/Installation
  204.        ------------------
  205.  
  206.      The following files should be contained in this ZIP archive:
  207.  
  208.        TVAULT  .DOC  -  Time Vault documentation file
  209.        TVAULT  .EXE  -  The actual Time Vault program file
  210.        TVUPDATE.TXT  -  Update information on Time Vault
  211.        TV-ORDER.FRM  -  Order form for registering
  212.  
  213.      (If any of these files are missing, please ask the sysop of the BBS
  214.       from which you obtained it to remove the archive from his system.)
  215.  
  216.  
  217.      Because Time Vault is designed specifically for Searchlight, it is one
  218.   of the easiest programs to setup.  Please follow these easy steps:
  219.  
  220.  
  221.      Place the TVAULT.EXE file somewhere on your harddrive.  We suggest
  222.   your main BBS directory.  The same directory that you keep BBS.EXE,
  223.   FILE.EXE, etc, in.
  224.  
  225.  
  226.      Next, make an entry into your DOORS.DEF file.  Follow the format of
  227.   the one below.
  228.  
  229.           2;0;1;30;Time Vault - Store Time;.;C:\BBS\TVAULT.EXE
  230.           | | | |           |              |        |
  231.           a b c d           e              f        g
  232.  
  233.        a) Tells Searchlight to provide communications support.  Set this to
  234.           a (2), telling Searchlight to send color to the remote user even
  235.           if the local BBS computer is monochrome.
  236.  
  237.        b) Disk-drive write protection during door.  This must be set to a
  238.           (0) to allow Time Vault to write it's information.
  239.  
  240.        c) Action on carrier loss.  Set this to a (1), telling Searchlight
  241.           to terminate the door program if the carrier is dropped during
  242.           door execution.
  243.  
  244.        d) BBS access level required to use door.
  245.  
  246.        e) Description of door displayed to your users.
  247.  
  248.        f) Directory to switch to before executing door.  This should ALWAYS
  249.           be set to a PERIOD ONLY as it is above.  Time Vault looks in the
  250.           current directory only when trying to read the CONFIG.SL2 file.
  251.           Making this a PERIOD will ensure that the correct CONFIG.SL2 file
  252.           is always found.
  253.  
  254.        g) The full path and file to the TVAULT.EXE file.
  255.  
  256.  
  257.      If you have additional DOOR.DEF files for other nodes, make identical
  258.   entries in those also.
  259.  
  260.  
  261.  
  262.                                      - 3 -
  263.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  264.  
  265.  
  266.  
  267.  
  268.      That's it.  You've installed Time Vault, with the basic, default
  269.   setup.  Not too tough, eh?  <grin> The basic installation allows:
  270.  
  271.      - maximum account balance of 60 minutes.
  272.      - maximum daily balance of 30 minutes.
  273.      - "Deposit", "Withdraw" and "Quit" menu options.
  274.  
  275.      To customize this installation, as well as activating extra options,
  276.   please see the next section.
  277.  
  278.  
  279.      -------------------------------
  280.      Advanced Options/Extra Features
  281.      -------------------------------
  282.  
  283.      Time Vault, without any additional command line switches, will operate
  284.   just fine.  However, there are several options that can be enabled.  The
  285.   format for running Time Vault with these options is:
  286.  
  287.               TVAULT.EXE -[option-1] ... -[option-n]
  288.  
  289.  
  290.   ** DEPOSIT **
  291.  
  292.      The deposit command allows your users to store a maximum of anywhere
  293.   between 0 and 32767 minutes in their 'account.'  By default, the maximum
  294.   balance is set to 60 minutes.
  295.  
  296.      To allow users to store MORE time, you can run Time Vault with the
  297.   '-MB=' paramemter.  To allow users to store 500 minutes of time, you
  298.   would run Time Vault with this command line:
  299.  
  300.      TVAULT.EXE -MB=500
  301.  
  302.      This would now allow account balances of 500 minutes.  See the section
  303.   on the TVAULT.CFG file for another configuration option of maximum
  304.   balances.
  305.  
  306.  
  307.   ** WITHDRAW **
  308.  
  309.      The withdraw command allows your users to take time out of their
  310.   account.  By default, the user can remove 30 minutes/day.  The range of
  311.   daily withdrawal values is 0-1440.  A maximum withdrawal of 0 disables
  312.   the daily withdrawal limit.
  313.  
  314.      To allow users to withdraw more than 30 minutes/day, you can use the
  315.   '-MW=' command line switch.  To allow users to withdraw up to 200
  316.   minutes/day, run Time Vault with this command line:
  317.  
  318.      TVAULT.EXE -MW=200
  319.  
  320.      This would now allow daily withdrawals of 200 minutes.  See the
  321.   section on the TVAULT.CFG file for another configuration method of
  322.   maximum withdraws.
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                                      - 4 -
  329.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  330.  
  331.  
  332.  
  333.  
  334.   ** TVAULT.CFG File **
  335.  
  336.      The TVAULT.CFG file give the sysop the ability of assigning maximum
  337.   balance and maximum daily withdrawal limits based on the users access
  338.   level.  By doing this, you may give higher level users the ability to
  339.   store or withdraw more time than lower level users.
  340.  
  341.      When Time Vault is trying to determine what the settings of maximum
  342.   balances and maximum daily withdrawals is, it performs the following
  343.   steps:
  344.  
  345.      - Looks in the current nodes CONFIG.SL2 directory for TVAULT.CFG
  346.      - Looks in the main data directory for TVAULT.CFG
  347.      - Looks at the TVAULT.EXE command line for switches
  348.      - Uses internal defaults
  349.  
  350.      On a single node system, place the TVAULT.CFG file into your main data
  351.   directory.
  352.  
  353.      If you operate a multinode system, the TVAULT.CFG file can reside in 1
  354.   of 2 places.  You can place it into your CONFIG.SL2 directory.  If you
  355.   put it here, the TVAULT.CFG file becomes specific to that node only.  Or,
  356.   you can place it into your main data directory, making that configuration
  357.   file global to all nodes.
  358.  
  359.      The format of the TVAULT.CFG file very simple.  You can create the
  360.   file using any text editor program.  Even use Searchlight's built in
  361.   editor if you like.  The file should be laid out as follows:
  362.  
  363.      {access level} = {maximum balance};{maximum daily withdrawal}
  364.  
  365.      This file may contain as many lines as necessary.  When Time Vault
  366.   reads this file, it attempts to match an access level that is less than
  367.   or equal to the current user's access level.
  368.  
  369.      Here is a sample TVAULT.CFG file:
  370.  
  371.      10 = 30;15
  372.      50 = 60;60
  373.      100 = 120;0
  374.  
  375.      Now, if a user runs Time Vault, this is what his maximum withdrawals
  376.   and maximum balance settings will be set to:
  377.  
  378.      User Access     Maximum Balance     Maximum Withdrawal
  379.         10               30 minutes           15 minutes
  380.         50               60   "               60   "
  381.         20               30   "               15   "
  382.          5                0   "              (no limit)
  383.        150              120   "              (no limit)
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.                                      - 5 -
  395.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  396.  
  397.  
  398.  
  399.  
  400.   ** TRANSFER **
  401.  
  402.      The transfer option allows users to trade time with other users.  It's
  403.   a very simple feature to operate.  By default, this option is not
  404.   available to you users, however, it can be enabled using the '-T' command
  405.   line switch like this:
  406.  
  407.      TVAULT.EXE -T
  408.  
  409.      A user can only transfer time that is IN their account.  The maximum a
  410.   user can transfer is equal to their account balance.  The amount they can
  411.   transfer to a specific user is determined by that users current balance
  412.   and the user doing the transferings maximum balance limit.
  413.  
  414.      For example, if Suzie Snowflake attempts to transfer time to user Joe
  415.   Blow and Suzie has 60 minutes in her account.  Joe has 15 minutes in his
  416.   account.  Suzie's maximum balance is 60 minutes.  Suzie's maximum balance
  417.   limit gets applied to Joe's account.  So, a maximum balance of 60 minutes
  418.   minus Joe's current balance of 15 leaves 45.  Suzie can transfer a
  419.   maximum of 45 minutes to Joe Blow.
  420.  
  421.      It is a simple, straightforward function.  You might want to try it
  422.   out yourself before deciding to let your users use it.
  423.  
  424.  
  425.   ** GOODBYE **
  426.  
  427.      The optional Goodbye command does just that.  Logs the user off your
  428.   BBS directly from the door program.  This command can be activated by
  429.   running Time Vault with the "-G" command as follows:
  430.  
  431.      TVAULT.EXE -G
  432.  
  433.      When a user selects this function, they are given an "Are you sure?"
  434.   question to confirm they wish to logoff.  If they choose Yes, the door
  435.   will terminate and look like it is returning to the BBS as normal.
  436.   HOWEVER when the BBS reloads, it thinks it just ran the auto-LOGOFF door,
  437.   and will immediately display your LOGOFF.TXT/ANS file and hangup.
  438.  
  439.      The only drawback of this command is that, when used, you auto-logoff
  440.   door does not get run.
  441.  
  442.  
  443.   ** SYSOP UTILITY **
  444.  
  445.      Time Vault has a Sysop Utility mode built into the program.  Getting
  446.   to this special utility menu can be done by one of three methods:
  447.  
  448.      1) Run the door as a user with 254 or 255 access.
  449.      2) Toggle the superuser flag and run the door.
  450.      3) Run Time Vault with the '-S' command line switch.
  451.  
  452.      The Utility menu has 3 options; "Edit", "List", and "Quit".
  453.  
  454.      The Edit command prompts you for a username (or partial user name) to
  455.   select.  Once a user is selected, the balance of their account can be
  456.   edited.  As the sysop, you can set the balance anywhere from 0 to the
  457.   maximum of 32767.  You are not limited to the settings on the command
  458.   line or in the TVAULT.CFG file.
  459.  
  460.                                      - 6 -
  461.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  462.  
  463.  
  464.  
  465.  
  466.      The LIST command allows you to display account information of your
  467.   users in a table format.  The information is displayed as "Balance",
  468.   "User Name", and "Last Transaction".  The listing can be aborted by
  469.   hitting the spacebar or control-C at anytime.
  470.  
  471.      AVAILABLE in the Registered Version of Time Vault--  You can choose to
  472.   output the information to either the screen, or to a file or DOS device.
  473.   If you choose "File/Print", you will be prompted to enter the output
  474.   filename.  To send the list to a disk file enter a filename.  If you want
  475.   the list sent to a printer or other DOS device, enter as "LPT1", "PRN",
  476.   etc.  The unregistered version only allows printing to the screen.
  477.  
  478.  
  479.   ** 2-SYSOP **
  480.  
  481.      I lied.  There is a 4th way to execute the Sysop Utility menu.  If a
  482.   user is currently running Time Vault and you want to get to the Sysop
  483.   Menu, turn on the superuser flag (ALT-S).  The NEXT time the Time Vault
  484.   menu is displayed, the "2-Sysop" command will appear.  Choosing this
  485.   option will take you to the Time Vault Sysop Utility menu.
  486.  
  487.  
  488.   ** LOCAL STATUS LINE **
  489.  
  490.      Time Vault can display a local status line that looks identical to the
  491.   Searchlight status line.  By default, the status line is not enabled.  To
  492.   activate it, use the '-L' command line switch like this:
  493.  
  494.      TVAULT.EXE -L
  495.  
  496.      When activated, you can use the following hot-keys on the local
  497.   computer:
  498.  
  499.      ALT-A  - toggles the sysop availability flag
  500.      ALT-S  - toggles the super user access flag
  501.      ALT-N  - toggles the sysop next flag
  502.      F8     - Toggles user information in the status line
  503.      F9     - Increases users current session time limit in 5
  504.                 minute intervals
  505.      F10    - Decreases users current session time limit in 5
  506.                 minute intervals
  507.  
  508.  
  509.      --------------------
  510.      Sample Command Lines
  511.      --------------------
  512.  
  513.   TVAULT.EXE -MB=1000 -G
  514.      Executes Time Vault with Deposit, Withdrawal, Goodbye and Quit options
  515.   active.  The maximum balance is set to 1000 minutes.  The maximum
  516.   withdrawal is set to 30 minutes (the default).
  517.  
  518.   TVAULT.EXE
  519.      Executes Time Vault with the Deposit, Withdraw, and Quit options
  520.   active.  Maximum balance is set to 60 minutes, Maximum withdrawal set to
  521.   30. (both defaults)
  522.  
  523.  
  524.  
  525.  
  526.                                      - 7 -
  527.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  528.  
  529.  
  530.  
  531.  
  532.   TVAULT.EXE -T -G -MB=500 -MW=100 -L
  533.      Executes Time Vault with Deposit, Withdraw, Transfer, Goodbye, and
  534.   quit options active.  Maximum balance is set to 500 minutes.  Maximum
  535.   withdrawal is set to 100 minutes/day.  The local status line is also
  536.   activated.
  537.  
  538.   TVAULT.EXE -S -L
  539.      Executes Time Vault in Sysop Utility mode.  Local status line is also
  540.   activated.
  541.  
  542.  
  543.      -----------------
  544.      Activity Log File
  545.      -----------------
  546.  
  547.      Time Vault automatically generates an activity log file when run.  The
  548.   activity log is placed into the main BBS directory.  There is only 1 log
  549.   file for all nodes in a multi-user setup.  The entries are in the
  550.   following format:
  551.  
  552.      {date} {time}  {username} {action} {number of minutes}
  553.  
  554.      For example:
  555.  
  556.      08/28/91 09:42  SUZIE SNOWFLAKE withdrew 20 minutes
  557.  
  558.      All Deposits, Withdrawals, and Transfers are logged.
  559.  
  560.  
  561.      ---------------
  562.      Sysop Chat Mode
  563.      ---------------
  564.  
  565.      At anytime during program execution, the sysop can enter chat mode
  566.   with the user by pressing <ALT-C> on the local computer keyboard.  This
  567.   chat mode operates and feels just like the Searchlight chat mode.  In
  568.   fact, your users won't even think about the fact that they are in a door
  569.   program.
  570.  
  571.      Hitting the <Escape> key on the local keyboard will exit chat mode.
  572.   Program execution will resume at the exact point at which you interrupted
  573.   it.
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.                                      - 8 -
  593.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  594.  
  595.  
  596.  
  597.  
  598.      ---------------
  599.      Acknowledgments
  600.      ---------------
  601.  
  602.      - Frank LaRosa, author of Searchlight BBS.
  603.      - Gregg Flagg, motivated me to write a time bank door for Searchlight,
  604.          as well as coming up with the name "Time Vault".
  605.      - Chris Costakis, for just being an annoying pest to get me to write a
  606.          version of Time Vault for the Shareware Searchlight.  And THEN he
  607.          switches to the extended version a week later.
  608.      - Borland International, for providing the world with Turbo Pascal,
  609.          which Time Vault is written in.
  610.  
  611.  
  612.      ----------
  613.      Disclaimer
  614.      ----------
  615.  
  616.      We hereby state that when we released this program, it had been tested
  617.   to the best of my abilities.  We will not be held liable for incidental
  618.   or consequential damages as the result of the use of this software.  We
  619.   give no warrantees or guarantees of anykind.
  620.  
  621.      We further state that there are no undocumented features in this
  622.   software.
  623.  
  624.      Your use of the software confirms your acceptance to the disclaimer
  625.   information.
  626.  
  627.  
  628.      --------
  629.      Footnote
  630.      --------
  631.      Comments, Suggestions, and Registrations may be mailed to:
  632.  
  633.             C.C.S. Systems
  634.             Attn: Jim Barry
  635.             PO Box 35487
  636.             Cleveland, OH  44135-0487
  637.  
  638.      And if your really in the mood to get in touch with me, (or at least
  639.   the latest release of Time Vault), you can call my BBS:
  640.  
  641.             Time Vault BBS  (pcp: OHCLE) (Starlink: 4222, 10077)
  642.             (216) 951-9150, 8-N-1, 3/12/2400 Baud
  643.  
  644.      And remember:  When a program has no bugs...  It's obsolete!
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.                                      - 9 -
  659.          Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
  660.  
  661.